<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.7"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>cpp-ipfs-http-client: /media/melroy/Data/Projects/cpp-ipfs-http-client/include/ipfs/http/transport.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">cpp-ipfs-http-client
   </div>
   <div id="projectbrief">IPFS C++ client library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_9fc725be01a8beaa700ba2c8e692d63d.html">ipfs</a></li><li class="navelem"><a class="el" href="dir_6fc15720c3161f973dd4a76203d657ee.html">http</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">transport.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Copyright (c) 2016-2023, The C++ IPFS client library developers</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"></span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment">Permission is hereby granted, free of charge, to any person obtaining a copy of</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment">this software and associated documentation files (the &quot;Software&quot;), to deal in</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment">the Software without restriction, including without limitation the rights to</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment">use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment">the Software, and to permit persons to whom the Software is furnished to do so,</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment">subject to the following conditions:</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"></span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment">The above copyright notice and this permission notice shall be included in all</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment">copies or substantial portions of the Software.</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"></span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment">THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment">IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment">FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment">COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment">IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="preprocessor">#ifndef IPFS_HTTP_TRANSPORT_H</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#define IPFS_HTTP_TRANSPORT_H</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#include &lt;iostream&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#include &lt;memory&gt;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceipfs.html">ipfs</a> {</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="keyword">namespace </span>http {</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="structipfs_1_1http_1_1FileUpload.html">   33</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structipfs_1_1http_1_1FileUpload.html">FileUpload</a> {</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="structipfs_1_1http_1_1FileUpload.html#a76d8546add495d01fd1dcd82ea8170ad">   35</a></span>  <span class="keyword">enum class</span> <a class="code hl_enumeration" href="structipfs_1_1http_1_1FileUpload.html#a76d8546add495d01fd1dcd82ea8170ad">Type</a> {</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span>    <a class="code hl_enumvalue" href="structipfs_1_1http_1_1FileUpload.html#a76d8546add495d01fd1dcd82ea8170adafc941c889c1d94c918bfd225c22aed65">kFileContents</a>,</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span>    <a class="code hl_enumvalue" href="structipfs_1_1http_1_1FileUpload.html#a76d8546add495d01fd1dcd82ea8170ada5bfe73daee1615146c6c4fa093c7d9ef">kFileName</a>,</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span>  };</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="structipfs_1_1http_1_1FileUpload.html#a778df02055fa7791c1c240dd6d27b3da">   43</a></span>  <span class="keyword">const</span> std::string <a class="code hl_variable" href="structipfs_1_1http_1_1FileUpload.html#a778df02055fa7791c1c240dd6d27b3da">path</a>;</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="structipfs_1_1http_1_1FileUpload.html#ab2b53f7ba47384f2b11b59c216449283">   46</a></span>  <a class="code hl_enumeration" href="structipfs_1_1http_1_1FileUpload.html#a76d8546add495d01fd1dcd82ea8170ad">Type</a> <a class="code hl_variable" href="structipfs_1_1http_1_1FileUpload.html#ab2b53f7ba47384f2b11b59c216449283">type</a>;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="structipfs_1_1http_1_1FileUpload.html#a7920e334ad3eee5830e99c818b8f456b">   50</a></span>  <span class="keyword">const</span> std::string <a class="code hl_variable" href="structipfs_1_1http_1_1FileUpload.html#a7920e334ad3eee5830e99c818b8f456b">data</a>;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span>};</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="classipfs_1_1http_1_1Transport.html">   54</a></span><span class="keyword">class </span><a class="code hl_class" href="classipfs_1_1http_1_1Transport.html">Transport</a> {</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="classipfs_1_1http_1_1Transport.html#a4e3fd7f011e46562ac7d2f9005061601">   60</a></span>  <span class="keyword">virtual</span> std::unique_ptr&lt;Transport&gt; <a class="code hl_function" href="classipfs_1_1http_1_1Transport.html#a4e3fd7f011e46562ac7d2f9005061601">Clone</a>() <span class="keyword">const</span> = 0;</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span> </div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span>  <span class="keyword">virtual</span> <span class="keyword">inline</span> <a class="code hl_function" href="classipfs_1_1http_1_1Transport.html#a415e5830dfb8c2e26996e6619c15c8a6">~Transport</a>();</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span> </div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"><a class="line" href="classipfs_1_1http_1_1Transport.html#a1b9139c6d768df23da1893ff54a8d75a">   72</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classipfs_1_1http_1_1Transport.html#a1b9139c6d768df23da1893ff54a8d75a">Fetch</a>(</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span>      <span class="keyword">const</span> std::string&amp; url,</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span>      <span class="keyword">const</span> std::vector&lt;FileUpload&gt;&amp; files,</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span>      std::iostream* response) = 0;</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span> </div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"><a class="line" href="classipfs_1_1http_1_1Transport.html#a4da291ea9be5e9bcf4faccd7cbfe87fc">   87</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classipfs_1_1http_1_1Transport.html#a4da291ea9be5e9bcf4faccd7cbfe87fc">StopFetch</a>() = 0;</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span> </div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"><a class="line" href="classipfs_1_1http_1_1Transport.html#a31f96b6c63538c26c81ab5f8d806d1a5">   96</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classipfs_1_1http_1_1Transport.html#a31f96b6c63538c26c81ab5f8d806d1a5">ResetFetch</a>() = 0;</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span> </div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"><a class="line" href="classipfs_1_1http_1_1Transport.html#ab06599853f7f2b11ad323a3d67df4cad">  101</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classipfs_1_1http_1_1Transport.html#ab06599853f7f2b11ad323a3d67df4cad">UrlEncode</a>(</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span>      <span class="keyword">const</span> std::string&amp; raw,</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span>      std::string* encoded) = 0;</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span>};</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span> </div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"><a class="line" href="classipfs_1_1http_1_1Transport.html#a415e5830dfb8c2e26996e6619c15c8a6">  108</a></span><span class="keyword">inline</span> <a class="code hl_function" href="classipfs_1_1http_1_1Transport.html#a415e5830dfb8c2e26996e6619c15c8a6">Transport::~Transport</a>() {}</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span> </div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span>} <span class="comment">/* namespace http */</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span>} <span class="comment">/* namespace ipfs */</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span> </div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="preprocessor">#endif </span><span class="comment">/* IPFS_HTTP_TRANSPORT_H */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aclassipfs_1_1http_1_1Transport_html"><div class="ttname"><a href="classipfs_1_1http_1_1Transport.html">ipfs::http::Transport</a></div><div class="ttdoc">Convenience interface for talking basic HTTP.</div><div class="ttdef"><b>Definition</b> transport.h:54</div></div>
<div class="ttc" id="aclassipfs_1_1http_1_1Transport_html_a1b9139c6d768df23da1893ff54a8d75a"><div class="ttname"><a href="classipfs_1_1http_1_1Transport.html#a1b9139c6d768df23da1893ff54a8d75a">ipfs::http::Transport::Fetch</a></div><div class="ttdeci">virtual void Fetch(const std::string &amp;url, const std::vector&lt; FileUpload &gt; &amp;files, std::iostream *response)=0</div><div class="ttdoc">Fetch the contents of a given URL.</div></div>
<div class="ttc" id="aclassipfs_1_1http_1_1Transport_html_a31f96b6c63538c26c81ab5f8d806d1a5"><div class="ttname"><a href="classipfs_1_1http_1_1Transport.html#a31f96b6c63538c26c81ab5f8d806d1a5">ipfs::http::Transport::ResetFetch</a></div><div class="ttdeci">virtual void ResetFetch()=0</div><div class="ttdoc">Reset the internal state, after StopFetch() is called.</div></div>
<div class="ttc" id="aclassipfs_1_1http_1_1Transport_html_a415e5830dfb8c2e26996e6619c15c8a6"><div class="ttname"><a href="classipfs_1_1http_1_1Transport.html#a415e5830dfb8c2e26996e6619c15c8a6">ipfs::http::Transport::~Transport</a></div><div class="ttdeci">virtual ~Transport()</div><div class="ttdoc">Destructor.</div><div class="ttdef"><b>Definition</b> transport.h:108</div></div>
<div class="ttc" id="aclassipfs_1_1http_1_1Transport_html_a4da291ea9be5e9bcf4faccd7cbfe87fc"><div class="ttname"><a href="classipfs_1_1http_1_1Transport.html#a4da291ea9be5e9bcf4faccd7cbfe87fc">ipfs::http::Transport::StopFetch</a></div><div class="ttdeci">virtual void StopFetch()=0</div><div class="ttdoc">Stop the Fetch method abruptly.</div></div>
<div class="ttc" id="aclassipfs_1_1http_1_1Transport_html_a4e3fd7f011e46562ac7d2f9005061601"><div class="ttname"><a href="classipfs_1_1http_1_1Transport.html#a4e3fd7f011e46562ac7d2f9005061601">ipfs::http::Transport::Clone</a></div><div class="ttdeci">virtual std::unique_ptr&lt; Transport &gt; Clone() const =0</div><div class="ttdoc">Return a deep copy of this object.</div></div>
<div class="ttc" id="aclassipfs_1_1http_1_1Transport_html_ab06599853f7f2b11ad323a3d67df4cad"><div class="ttname"><a href="classipfs_1_1http_1_1Transport.html#ab06599853f7f2b11ad323a3d67df4cad">ipfs::http::Transport::UrlEncode</a></div><div class="ttdeci">virtual void UrlEncode(const std::string &amp;raw, std::string *encoded)=0</div><div class="ttdoc">URL encode a string.</div></div>
<div class="ttc" id="anamespaceipfs_html"><div class="ttname"><a href="namespaceipfs.html">ipfs</a></div><div class="ttdoc">IPFS namespace.</div><div class="ttdef"><b>Definition</b> client.h:33</div></div>
<div class="ttc" id="astructipfs_1_1http_1_1FileUpload_html"><div class="ttname"><a href="structipfs_1_1http_1_1FileUpload.html">ipfs::http::FileUpload</a></div><div class="ttdoc">HTTP file upload.</div><div class="ttdef"><b>Definition</b> transport.h:33</div></div>
<div class="ttc" id="astructipfs_1_1http_1_1FileUpload_html_a76d8546add495d01fd1dcd82ea8170ad"><div class="ttname"><a href="structipfs_1_1http_1_1FileUpload.html#a76d8546add495d01fd1dcd82ea8170ad">ipfs::http::FileUpload::Type</a></div><div class="ttdeci">Type</div><div class="ttdoc">The type of the data member.</div><div class="ttdef"><b>Definition</b> transport.h:35</div></div>
<div class="ttc" id="astructipfs_1_1http_1_1FileUpload_html_a76d8546add495d01fd1dcd82ea8170ada5bfe73daee1615146c6c4fa093c7d9ef"><div class="ttname"><a href="structipfs_1_1http_1_1FileUpload.html#a76d8546add495d01fd1dcd82ea8170ada5bfe73daee1615146c6c4fa093c7d9ef">ipfs::http::FileUpload::Type::kFileName</a></div><div class="ttdeci">@ kFileName</div><div class="ttdoc">File whose contents is streamed to the web server.</div></div>
<div class="ttc" id="astructipfs_1_1http_1_1FileUpload_html_a76d8546add495d01fd1dcd82ea8170adafc941c889c1d94c918bfd225c22aed65"><div class="ttname"><a href="structipfs_1_1http_1_1FileUpload.html#a76d8546add495d01fd1dcd82ea8170adafc941c889c1d94c918bfd225c22aed65">ipfs::http::FileUpload::Type::kFileContents</a></div><div class="ttdeci">@ kFileContents</div><div class="ttdoc">The file contents, put into a string by the caller.</div></div>
<div class="ttc" id="astructipfs_1_1http_1_1FileUpload_html_a778df02055fa7791c1c240dd6d27b3da"><div class="ttname"><a href="structipfs_1_1http_1_1FileUpload.html#a778df02055fa7791c1c240dd6d27b3da">ipfs::http::FileUpload::path</a></div><div class="ttdeci">const std::string path</div><div class="ttdoc">File name to pretend to the web server.</div><div class="ttdef"><b>Definition</b> transport.h:43</div></div>
<div class="ttc" id="astructipfs_1_1http_1_1FileUpload_html_a7920e334ad3eee5830e99c818b8f456b"><div class="ttname"><a href="structipfs_1_1http_1_1FileUpload.html#a7920e334ad3eee5830e99c818b8f456b">ipfs::http::FileUpload::data</a></div><div class="ttdeci">const std::string data</div><div class="ttdoc">The data to be added.</div><div class="ttdef"><b>Definition</b> transport.h:50</div></div>
<div class="ttc" id="astructipfs_1_1http_1_1FileUpload_html_ab2b53f7ba47384f2b11b59c216449283"><div class="ttname"><a href="structipfs_1_1http_1_1FileUpload.html#ab2b53f7ba47384f2b11b59c216449283">ipfs::http::FileUpload::type</a></div><div class="ttdeci">Type type</div><div class="ttdoc">The type of the data member.</div><div class="ttdef"><b>Definition</b> transport.h:46</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7
</small></address>
</body>
</html>
